Skip to content

feat(release): add CHANGELOG and release notes to GitHub releases#142

Merged
stephenleo merged 4 commits intomainfrom
feat/changelog-and-release-notes
Mar 28, 2026
Merged

feat(release): add CHANGELOG and release notes to GitHub releases#142
stephenleo merged 4 commits intomainfrom
feat/changelog-and-release-notes

Conversation

@stephenleo
Copy link
Copy Markdown
Owner

Summary

  • Adds CHANGELOG.md with entries for all releases from v0.0.1-rc1 through v1.4.0
  • Updates .github/workflows/release.yml so every GitHub release body shows the curated CHANGELOG section on top, followed by auto-generated PR/commit notes below
  • Release notes are extracted from CHANGELOG.md by version tag using awk; falls back to a generic message if no entry exists

How it works

  1. The release job checks out the repo at the release tag to access CHANGELOG.md
  2. An awk script extracts the section matching the current version (e.g. ## [1.4.0])
  3. softprops/action-gh-release@v2 renders the extracted notes as the release body, then appends GitHub's auto-generated contributor/PR list below

Test plan

  • Verify CHANGELOG.md renders correctly on GitHub
  • Trigger a test release and confirm the release body shows CHANGELOG content above auto-generated notes
  • Confirm fallback message appears for a version with no CHANGELOG entry

🤖 Generated with Claude Code

stephenleo and others added 4 commits March 28, 2026 19:29
CHANGELOG.md section for the release tag is extracted and placed as the
release body; GitHub's auto-generated PR/commit list is appended below via
generate_release_notes: true in softprops/action-gh-release@v2.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude
Copy link
Copy Markdown

claude bot commented Mar 28, 2026

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@stephenleo stephenleo merged commit e3c42a4 into main Mar 28, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant